Skip to content

Conversation

@skeptrunedev
Copy link
Contributor

@skeptrunedev skeptrunedev commented Jul 11, 2025

Documentation changes

Changes the discovery API openapi spec to remove the old topic and message routes and add the new Generate assistant message route.

Closes half of https://linear.app/mintlify/issue/ENG-3707/update-chat-endpoints-to-single-assistant-endpoint


For Reviewers

When reviewing documentation PRs, please consider:

✅ Technical accuracy

  • Code examples work as written
  • Commands and configurations are correct
  • Links resolve to the right destinations
  • Prerequisites and requirements are accurate

✅ Clarity and completeness (N/A since this is just an api request)

  • Instructions are clear and easy to follow
  • Steps are in logical order
  • Nothing important is missing
  • Examples help illustrate the concepts

✅ User experience

  • A new user could follow these docs successfully
  • Common gotchas or edge cases are addressed
  • Error messages or troubleshooting guidance is helpful

…w request structure and additional properties
@skeptrunedev skeptrunedev marked this pull request as ready for review July 11, 2025 17:20
@skeptrunedev skeptrunedev force-pushed the nick/eng-3707-update-chat-endpoints-to-single-assistant-endpoint branch 2 times, most recently from 684279f to 98477ac Compare July 11, 2025 17:22
Comment on lines +1 to +13
# Mintlify Documentation

Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command

```
npm i -g mintlify
```

Run the following command at the root of your documentation (where mint.json is)

```
mintlify dev
```
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Open source repo so I thought fit to give it at least a bit of a README lol. More effort might be warranted for this at some point in the future.

@skeptrunedev skeptrunedev changed the title Refactor API endpoint to generate assistant messages with updated request and response structures #3707 Refactor API endpoint to generate assistant messages with updated request and response structures Jul 11, 2025
@skeptrunedev skeptrunedev requested a review from a team July 11, 2025 17:28
Copy link
Contributor

@mayankshouche mayankshouche left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one small q before signing off!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to dogfood our own features, we might want to add a new tag here: https://mintlify.com/docs/pages#param-tag

defer to @ethanpalm if we actually want this or not though!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Happy to add that if desired!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can totally merge without for now but depending on Ethan's preference we can add it in a follow-up :)

Copy link
Contributor

@mayankshouche mayankshouche left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks great!

@skeptrunedev skeptrunedev merged commit 3eb582f into main Jul 11, 2025
4 checks passed
@skeptrunedev skeptrunedev deleted the nick/eng-3707-update-chat-endpoints-to-single-assistant-endpoint branch July 11, 2025 23:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants